XV. Tools Commands

The tools command node is used to perform procedures that help restore data in the event of a disaster such as a catastrophic RAID failure. The tools command node includes the following subnodes:

  • cifs

  • filestorage

  • raid

  • storage

  • system

Table of Contents
CIFS Tools Commands —
tools cifs domains modify — Use the tools cifs domains modify command to modify a CIFS domain.
tools cifs domains rename — Use the tools cifs domains rename command to change the name of a CIFS domain without changing the domain's security identifier (SID).
tools cifs domains show — Use the tools cifs domains show command to dispaly information about CIFS domains.
File Storage Tools Commands —
File Storage Lost-and-Found Tools Commands —
tools filestorage lostnfound claim — Use the tools filestorage lostnfound claim command to restore a lost VFS to the management framework.
tools filestorage lostnfound delete — Use the tools filestorage lostnfound delete command to delete a lost VFS.
tools filestorage lostnfound show — Use the tools filestorage lostnfound show command to display information about lost VFSs.
File Storage Mirror Tools Commands —
tools filestorage mirror delete — Use the tools filestorage mirror delete command to remove a mirrored VFS from the mirror group and to delete a VFS mirror.
tools filestorage mirror leavegroup — Use the tools filestorage mirror leavegroup command to remove a virtual file system (VFS) mirror from a mirror group and convert it to read-write access.
tools filestorage mirror show — Use the tools filestorage mirror show command to display information about mirrored VFSs.
File Storage VFS Tools Commands —
tools filestorage vfs deletefamily — Use the tools filestorage vfs deletefamily command to delete a read-write VFS and all of its associated SpinShots and mirrors.
tools filestorage vfs deletefile — Use the tools filestorage vfs deletefile command to delete a specified file from a VFS.
tools filestorage vfs deletemountpoint — Use the tools filestorage vfs deletemountpoint command to delete a VFS's mount point.
tools filestorage vfs forcedelete — Use the tools filestorage vfs forcedelete command to force the deletion of a VFS.
tools filestorage vfs forceunmount — Use the tools filestorage vfs forceunmount command to force the unmounting of a VFS.
tools filestorage vfs makereadonly — Use the tools filestorage vfs makereadonly command to make a virtual file system read-only.
tools filestorage vfs makereadwrite — Use the tools filestorage vfs makereadwrite command to make a virtual file system (VFS) read-write.
tools filestorage vfs makereadwritemountpoints — Use the tools filestorage vfs makereadwritemountpoints command to create .readwrite mount points in a VFS after an upgrade of SpinFS 1.x to 2.x.
tools filestorage vfs makeroot — Use the tools filestorage vfs makeroot command to make a VFS the root VFS of the virtual server.
tools filestorage vfs migratefamily — Use the tools filestorage vfs migratefamily command to migrate a VFS to another virtual server.
tools filestorage vfs modify — Use the tools filestorage vfs modify command to modify the minimum quota, maximum quota, user type, domain, user, or group of an existing virtual file system.
tools filestorage vfs promote — Use the tools filestorage vfs promote command to promote a mirror, a SpinShot, or a SpinShot of a mirror to the parent read-write VFS.
tools filestorage vfs rename — Use the tools filestorage vfs rename command to rename a read-write virtual file system (VFS).
tools filestorage vfs setoffline — Use the tools filestorage vfs setoffline command to take a VFS offline.
tools filestorage vfs setonline — Use the tools filestorage vfs setonline command to put a VFS online.
tools filestorage vfs show — Use the tools filestorage vfs show command to display configuration details of a virtual file system.
tools filestorage vfs show-access — Use the tools filestorage vfs show-access command to display information about export rule sets for one or more virtual file systems (VFSs).
tools filestorage vfs show-all — Use the tools filestorage vfs show-all command to display a listing of all virtual file systems (VFSs), including read-only VFSs such as SpinShots and mirrors.
tools filestorage vfs show-family — Use the tools filestorage vfs show-family command to display the read-only virtual file systems (VFSs), such as SpinShots and mirrors, that are associated with a read-write virtual file system.
tools filestorage vfs show-mount — Use the tools filestorage vfs show-mount command to display mount-path information for a specific virtual file system or for all virtual file systems.
tools filestorage vfs show-vs — Use the tools filestorage vfs show-vs command to display virtual server information for a specific VFS or for all VFSs.
RAID Tools Commands —
RAID Sets Tools Commands —
tools raid sets delete — Use the tools raid sets delete command to delete a RAID set.
tools raid sets forcedelete — Use the tools raid sets forcedelete command to forcibly delete a RAID set.
tools raid sets new — Use the tools raid sets new command to create a RAID set.
tools raid sets show — The tools raid sets show command displays information about the RAID sets in a RAID subsystem.
tools raid sets show-disks — Use the tools raid sets show-disks command to display the IDs of the disks that comprise a RAID set.
Storage Tools Commands —
Storage Pools Tools Commands —
tools storage pools forceaddpassive — Use the tools storage pools forceaddpassive command to forcibly add a passive secondary server to a storage pool.
tools storage pools forcedelete — Use the tools storage pools forcedelete command to forcibly delete a storage pool.
tools storage pools forceoffline — Use the tools storage pools forceoffline command to forcibly take a storage pool offline.
tools storage pools forcetakeover — Use the tools storage pools forcetakeover command to force a SpinServer to take over as the primary server for a storage pool.
tools storage pools show — Use the tools storage pools show command to display information about one or more storage pools known to a SpinServer.
Storage Units Tools Commands —
tools storage units erase — Use the tools storage units erase command to erase all data on a storage unit.
tools storage units modify — Use the tools storage units modify command to set the primary host channel for a storage unit.
tools storage units show — Use the tools storage units show command to display information about all storage units located on a SpinServer.
System Tools Commands —
tools system rootfilesystem forceupgrade — Use the tools system rootfilesystem forceupgrade command to force a software upgrade.
tools system rootfilesystem modify — Use the tools system rootfilesystem modify command to set the synchronization value for a SpinServer's root file system at the next system restart.
tools system rootfilesystem show — Use the tools system rootfilesystem show command to display information about a SpinServer's root file-system partitions.

CIFS Tools Commands

Name

CIFS Tools Commands -- 

The tools cifs node includes the domains subnode, which includes the following commands:


tools cifs domains modify

Name

tools cifs domains modify -- Use the tools cifs domains modify command to modify a CIFS domain.

Synopsis

CLI:

tools cifs domains modify -domainname CIFS_domain_name [-winsip WINS_IP_address] -pdcname primary_domain_controller_name -pdcip primary_domain_controller_IP_address [-kerbconf Kerberos_configuration_name] [-bdcname1 backup_domain_controller_name] [-bdcip1 backup_domain_controller_IP_address] [-bdcname2 backup_domain_controller_name] [-bdcip2 backup_domain_controller_IP_address] [-bdcname3 backup_domain_controller_name] [-bdcip3 backup_domain_controller_IP_address] [-bdcname4 backup_domain_controller_name] [-bdcip4 backup_domain_controller_IP_address]

GUI: Navigate to the Tools → CIFS → Domains node, then select the appropriate domain from the table and run the Show command from the drop-down menu of the action pane. Make the appropriate modifications in the table that is displayed, then run the Modify command from the drop-down menu.

Description

To modify a CIFS domain, use the tools cifs domains modify command. The -domainname option specifies the domain that is to be modified, and the other options specify the new values for that domain.

Note: This command provides the same functionality as the spinaccess cifs domains modify command. It is duplicated in the tools command node for easy access when you are working in the tools node.

Options

-domainname CIFS_domain_name

This is the NetBIOS name of the CIFS domain.

[-winsip WINS_IP_address]

This is the WINS IP address. This parameter is optional. When a virtual server is added to the domain, it must be of type B if the domain does not have a WINS IP address. If you create a CIFS domain with a WINS IP address and add a virtual server with a node type that is not B (that is, it is M, P, or H), the domain must have a WINS IP address.

-pdcname primary_domain_controller_name

This is the NetBIOS name of the primary domain controller (PDC).

-pdcip primary_domain_controller_IP_address

This is the IP address of the primary domain controller.

[-kerbconf Kerberos_configuration_name]

This is the name of the Kerberos configuration to be associated with the CIFS domain. The name of the Kerberos configuration is specified by the -configname parameter of the spinaccess kerberos realm new command.

[-bdcname1 backup_domain_controller_name]

This is the NetBIOS name of the backup domain controller (BDC).

[-bdcip1 backup_domain_controller_IP_address]

This is the IP address of the backup domain controller.

[-bdcname2 backup_domain_controller_name]

This is the NetBIOS name of the second BDC.

[-bdcip2 backup_domain_controller_IP_address]

This is the IP address of the second BDC.

[-bdcname3 backup_domain_controller_name]

This is the NetBIOS name of the third BDC.

[-bdcip3 backup_domain_controller_IP_address]

This is the IP address of the third BDC.

[-bdcname4 backup_domain_controller_name]

This is the NetBIOS name of the fourth BDC.

[-bdcip4 backup_domain_controller_IP_address]

This is the IP address of the fourth BDC.

Example

The following command example modifies a CIFS domain named ENG. The WINS IP address is 10.1.1.11. The PDC name is STORM and its IP address is 10.1.1.11. The BDC name is RAIN and its IP address is 10.1.1.117.

spinserver::> tools cifs domains modify -domainname ENG -winsip 10.1.1.11 -pdcname STORM -pdcip 10.1.1.11 -bdcname1 RAIN -bdcip1 10.1.1.117

tools cifs domains rename

Name

tools cifs domains rename -- Use the tools cifs domains rename command to change the name of a CIFS domain without changing the domain's security identifier (SID).

Synopsis

CLI:

tools cifs domains rename -domainname domain_name -newname new_domain_name

GUI: Navigate to the Tools → CIFS → Domains node, then select the appropriate domain from the table and run the Rename command from the drop-down menu of the action pane. Enter the appropriate information into the table that is displayed and click Rename.

Description

The tools cifs domains rename command changes the name of a CIFS domain without changing the domain's SID.

Caution:

Changing the name of a CIFS domain improperly can result in the CIFS domain becoming inaccessible. Use extreme care when running this command.

Options

-domainname domain_name

This specifies the name of CIFS domain that is to be changed.

-newname new_domain_name

This specifies the new name of the CIFS domain.

Example

The following example changes the name of a CIFS domain from WATERMELON to CANTALOUPE.

spinserver::> tools cifs domains rename -domainname WATERMELON -newname CANTALOUPE

tools cifs domains show

Name

tools cifs domains show -- Use the tools cifs domains show command to dispaly information about CIFS domains.

Synopsis

CLI:

tools cifs domains show [-domainname CIFS_domain_name]

GUI: Navigate to the Tools → CIFS → Domains node. To display information about a specific domain, select it from the table and run the Show command from the drop-down menu of the action pane.

Description

The tools cifs domains show command, without the parameter, displays summary configuration information about all currently defined CIFS domains within the system. To display information about a specific CIFS domain, use the command with the -domainname parameter. When you specify a domain, the following information is displayed:

Note: This command provides the same functionality as the spinaccess cifs domains show command. It is duplicated in the tools command node for easy access when you are working in the tools node.

Options

[-domainname CIFS_domain_name]

This is the name of the CIFS domain.

Example

The following example displays information about all CIFS domains.

spinserver::> tools cifs domains show
Domain         PDC Name     Kerberos Config

CIFSLAND        STORM
ENG             XAVIER      example.com
SLAB            STPDC
SUPPORT         SUPPORT-W2K

The following command example displays information about a CIFS domain named ENG.

spinserver::> tools cifs domains show -domainname ENG
   Domain                        ENG
   Windows SID                   S-1-5-21-393965755-660102513-868425949
   WINS                          10.1.1.41
   PDC Name                      XAVIER
   PDC IP                        10.1.1.41
   Kerberos Configuration Name   example.com
   BDC 1 Name                    MAGNETO
   BDC 1 IP                      10.1.1.42
   BDC 2 Name
   BDC 2 IP
   BDC 3 Name
   BDC 3 IP
   BDC 4 Name
   BDC 4 IP

File Storage Tools Commands

Name

File Storage Tools Commands -- 

The tools filestorage node includes the following subnodes:


File Storage Lost-and-Found Tools Commands

Name

File Storage Lost-and-Found Tools Commands -- 

The tools filestorage lostnfound subnode includes the following commands:


tools filestorage lostnfound claim

Name

tools filestorage lostnfound claim -- Use the tools filestorage lostnfound claim command to restore a lost VFS to the management framework.

Synopsis

CLI:

tools filestorage lostnfound claim -vfsid VFS_ID -spdevid storage_pool_ID

GUI: Navigate to the Tools → File Storage → Lost and Found node, then select the appropriate VFS from the table and run the Claim command from the drop-down menu of the action pane.

Description

The tools filestorage lostnfound claim command restores a lost VFS to the management framework. A lost VFS is known to a storage pool but not to the management framework.

Note: This command must be run on the SpinServer that owns the storage pool on which the lost VFS is located.

Options

-vfsid VFS_ID

This specifies the ID of the VFS.

-spdevid storage_pool_ID

This specifies the ID of the storage pool on which the VFS is located.

Example

The following example restores a VFS with ID 782693 on storage pool sp14 to the management framework.

spinserver::> tools filestorage lostnfound claim -vfsid 782693 -spdevid sp14

tools filestorage lostnfound delete

Name

tools filestorage lostnfound delete -- Use the tools filestorage lostnfound delete command to delete a lost VFS.

Synopsis

CLI:

tools filestorage lostnfound delete -vfsid VFS_ID -spdevid storage_pool_ID

GUI: Navigate to the Tools → File Storage → Lost and Found node, then select the appropriate VFS from the table and run the Delete command from the drop-down menu of the action pane.

Description

The tools filestorage lostnfound delete command deletes a lost VFS. A lost VFS is known to a storage pool but not to the management framework.

Note: This command must be run on the SpinServer that owns the storage pool on which the lost VFS is located.

Options

-vfsid VFS_ID

This specifies the ID of the VFS.

-spdevid storage_pool_ID

This specifies the ID of the storage pool on which the VFS is located.

Example

The following example deletes a VFS with ID 788624 on storage pool sp14.

spinserver::> tools filestorage lostnfound delete -vfsid 788624 -spdevid sp14

tools filestorage lostnfound show

Name

tools filestorage lostnfound show -- Use the tools filestorage lostnfound show command to display information about lost VFSs.

Synopsis

CLI:

tools filestorage lostnfound show [-vfsid VFS_ID -spdevid storage_pool_ID]

GUI: Navigate to the Tools → File Storage → Lost and Found node. To display information about a specific VFS, select it from the table and run the Show command from the drop-down menu of the action pane.

Description

The tools filestorage lostnfound show command displays information about a specific lost VFS or about all lost VFSs. A lost VFS is known to a storage pool but not to the management framework. The command displays the following information:

The command displays the following additional information if run on a specific VFS:

Note: This command must be run on the SpinServer that owns the storage pool on which the lost VFS or VFSs are located. For instance, if you want to locate all lost VFSs in a cluster, you must log in individually to each of the cluster's SpinServers and run the command.

Options

[-vfsid VFS_ID]

This specifies the ID of the VFS.

[-spdevid storage_pool_ID]

This specifies the ID of the storage pool on which the VFS is located.

Example

The following example displays information about all lost VFSs.

spinserver::> tools filestorage lostnfound show
VFS ID    Storage       VFS         Type     Mounted    Upstream  Downstream   Status  
           Pool                               From      VFS ID     VFS ID  

782693     sp14  lg14_vfs11.782693 spinshot                0          0        online    
782696     sp14  lg14_vfs10.782696 spinshot                0          0        online    
782714     sp14  lg14_vfs12.782714 spinshot                0          0        online    
788624     sp15  lg14_vfs13.788624 spinshot                0          0        online    

File Storage Mirror Tools Commands

Name

File Storage Mirror Tools Commands -- 

The tools filestorage mirror subnode includes the following commands:


tools filestorage mirror delete

Name

tools filestorage mirror delete -- Use the tools filestorage mirror delete command to remove a mirrored VFS from the mirror group and to delete a VFS mirror.

Synopsis

CLI:

tools filestorage mirror delete -sourcevfsname source_VFS_name -sinkvfsname sink_VFS_name

GUI: Navigate to the Tools → File Storage → Mirrors node, then select the appropriate mirror from the table and run the Delete command from the drop-down menu of the action pane.

Description

The filestorage mirror delete command removes a mirrored VFS from the mirror group and deletes its VFS mirror.

Caution:

If you have a VFS that is mirrored to two storage pools and you want to delete one of the mirrors, ensure that all mirrors are replicated immediately before deleting any mirrors, or otherwise ensure that all mirrors are synchronized with the source VFS before deleting any mirrors. This prevents clients from receiving potentially out-of-date data from an obsolete mirror.

Note: This command provides the same functionality as the filestorage mirror delete command. It is duplicated in the tools command node for easy access when you are working in the tools node.

Options

-sourcevfsname source_VFS_name

This is the name of the mirrored VFS that is to be removed from the mirror group and have its VFS mirror deleted.

-sinkvfsname sink_VFS_name

This is the name of the VFS mirror that is to be deleted.

Example

The following example deletes a mirror named vfs1_m1 of a VFS named vfs1:

spinserver::> tools filestorage mirror delete -sourcevfsname vfs1 -sinkvfsname vfs1_m1

tools filestorage mirror leavegroup

Name

tools filestorage mirror leavegroup -- Use the tools filestorage mirror leavegroup command to remove a virtual file system (VFS) mirror from a mirror group and convert it to read-write access.

Synopsis

CLI:

tools filestorage mirror leavegroup -sourcevfsname source_VFS_name -sinkvfsname sink_VFS_name -newvfsname new_VFS_name

GUI: Navigate to the Tools → File Storage → Mirrors node, then select the appropriate mirror from the table and run the Leave Group command from the drop-down menu of the action pane.

Description

The tools filestorage mirror leavegroup command removes a virtual file system (VFS) mirror from a mirror group. When a mirror is removed from the mirror group, no more manual or automatic updates from the original VFS can occur.

Options

-sourcevfsname source_VFS_name

This specifies the name of the mirrored VFS whose mirror is to be removed from the mirror group.

-sinkvfsname sink_VFS_name

This specifies the name of the VFS mirror that is to be removed from the mirror group.

-newvfsname new_VFS_name

This specifies the name of the VFS after it is removed from the mirror group.

Example

The following example removes a VFS mirror named vfs1_m1, which is a mirror of the VFS named vfs1, from the mirror group. The VFS is named old.vfs1.mirror after it leaves the mirror group.

spinserver::> tools filestorage mirror leavegroup -sourcevfsname vfs1 -sinkvfsname vfs1_m1 -newvfsname old.vfs1.mirror

tools filestorage mirror show

Name

tools filestorage mirror show -- Use the tools filestorage mirror show command to display information about mirrored VFSs.

Synopsis

CLI:

tools filestorage mirror show [-sourcevfsname source_VFS_name -sinkvfsname sink_VFS_name]

GUI: Navigate to the Tools → File Storage → Mirror node. To display information about a specific mirror, select it from the table and run the Show command from the drop-down menu in the action pane.

Description

The tools filestorage mirror show command displays information about all mirrored VFSs or for a specified mirrored VFS. The information includes the following:

Use the command with no argument to display information about all mirrored VFSs, or with the -vfsname argument to display information about a specific mirrored VFS.

Note: This command provides the same functionality as the filestorage mirror show command. It is duplicated in the tools command node for easy access when you are working in the tools node.

Options

[-sourcevfsname source_VFS_name]

This is the name of the mirrored VFS for which information is to be displayed.

[-sinkvfsname sink_VFS_name]

This is the name of the VFS mirror for which information is to be displayed.

Example

The following example displays information about all mirrored VFSs:

spinserver::> tools filestorage mirror show 

Source VFS  Sink VFS  Source SP   Sink SP    Sink Vers       Status

vfs1       m.vfs1     pool0       pool1      1               online

File Storage VFS Tools Commands

Name

File Storage VFS Tools Commands -- 

The tools filestorage vfs subnode includes the following commands:


tools filestorage vfs deletefamily

Name

tools filestorage vfs deletefamily -- Use the tools filestorage vfs deletefamily command to delete a read-write VFS and all of its associated SpinShots and mirrors.

Synopsis

CLI:

tools filestorage vfs deletefamily -vfsname VFS_name

GUI: Navigate to the Tools → File Storage → Virtual File Systems node, then select the appropriate VFS from the table and run the Delete Family command from the drop-down menu of the action pane.

Description

The tools filestorage vfs deletefamily command deletes a read-write VFS and all of its associated SpinShots, mirrors, and SpinShots of mirrors. Use this command to delete an entire VFS family.

Options

-vfsname VFS_name

This specifies the name of the read-write VFS that is to be deleted along with all of its SpinShots, mirrors, and SpinShots of mirrors.

Example

The following example deletes a read-write VFS named user.gwo and all of its associated SpinShots and mirrors:

spinserver::> tools filestorage vfs deletefamily -vfsname user.gwo

tools filestorage vfs deletefile

Name

tools filestorage vfs deletefile -- Use the tools filestorage vfs deletefile command to delete a specified file from a VFS.

Synopsis

CLI:

tools filestorage vfs deletefile -vfsname VFS_name -path absolute_path_name

GUI: Navigate to the Tools → File Storage → Virtual File Systems node, then select the appropriate VFS from the table and run the Delete File command from the drop-down menu of the action pane. Enter the appropriate values into the table that is displayed, then click Delete File.

Description

The tools filestorage vfs deletefile command deletes a specified file from a VFS. This can be used to delete a file that is inaccessible from a CIFS or NFS client.

Options

-vfsname VFS_name

This specifies the name of the VFS from which a file is to be deleted.

-path absolute_path_name

This specifies the absolute path name of the file that is to be deleted.

Example

The following example deletes a file named /dept/eng/virus.exe from a VFS named dept.eng:

spinserver::> tools filestorage vfs deletefile -vfsname
dept.eng -path /dept/eng/virus.exe

tools filestorage vfs deletemountpoint

Name

tools filestorage vfs deletemountpoint -- Use the tools filestorage vfs deletemountpoint command to delete a VFS's mount point.

Synopsis

CLI:

tools filestorage vfs deletemountpoint -vfsname VFS_name -mountpath mount_path

GUI: Navigate to the Tools → File Storage → Virtual File Systems node, then select the appropriate VFS from the table and run the Delete Mount Point command from the drop-down menu of the action pane.

Description

The tools filestorage vfs deletemountpoint command deletes a VFS's mount point. Use this command if the forced deletions and unmountings of VFSs leave stray mount points on the parent VFS.

Options

-vfsname VFS_name

This specifies the name of the VFS that is to have its mount point deleted.

-mountpath mount_path

This specifies the mount path of the VFS that is to have its mount point deleted.

Example

The following example deletes the mount point of a VFS named bill that is mounted at /user/bill:

spinserver::> tools filestorage vfs deletemountpoint  -vfsname bill -mountpath /user/bill

tools filestorage vfs forcedelete

Name

tools filestorage vfs forcedelete -- Use the tools filestorage vfs forcedelete command to force the deletion of a VFS.

Synopsis

CLI:

tools filestorage vfs forcedelete -vfsname VFS_name -unmount {true | false}

GUI: Navigate to the Tools → File Storage → Virtual File Systems node, then select the appropriate VFS from the table and run the Force Delete command from the drop-down menu of the action pane.

Description

The tools filestorage vfs forcedelete command forces the deletion of a VFS. Use this command in the event that a VFS must be deleted when it is offline or otherwise unavailable. By default, the command attempts to unmount the VFS by deleting its mount point in its parent VFS. The VFS is then deleted whether or not the unmounting operation was successful.

Options

-vfsname VFS_name

This specifies the name of the VFS that is to be deleted.

-unmount {true | false}

This specifies whether or not to attempt to unmount the VFS before deleting it. The default is true.

Example

The following example forces the deletion of a VFS named vfs0. The command first attempts to unmount the VFS.

spinserver::> tools filestorage vfs forcedelete -vfsname vfs0 -unmount true

tools filestorage vfs forceunmount

Name

tools filestorage vfs forceunmount -- Use the tools filestorage vfs forceunmount command to force the unmounting of a VFS.

Synopsis

CLI:

tools filestorage vfs forceunmount -vfsname VFS_name

GUI: Navigate to the Tools → File Storage → Virtual File Systems node, then select the appropriate VFS from the table and run the Force Unmount command from the drop-down menu of the action pane.

Description

The tools filestorage vfs forceunmount command forces the unmounting of a VFS. Use this command in the event that the parent VFS is offline or otherwise inaccessible and a VFS needs to be unmounted. The command attempts to unmount the VFS by deleting its mount point in the parent VFS. If that attempt fails, the command clears the VFS's mount attributes, thus enabling the VFS to be mounted elsewhere. If this situation occurs, use the tools filestorage vfs deletemountpoint command to delete the VFS's mount point in the parent VFS when the parent VFS becomes available again.

Options

-vfsname VFS_name

This specifies the name of the VFS that is to be unmounted.

Example

The following example forces the unmounting of a VFS named vfs0:

spinserver::> tools filestorage vfs forceunmount -vfsname vfs0

tools filestorage vfs makereadonly

Name

tools filestorage vfs makereadonly -- Use the tools filestorage vfs makereadonly command to make a virtual file system read-only.

Synopsis

CLI:

tools filestorage vfs makereadonly -vfsname VFS_name

GUI: Navigate to the Tools → File Storage → Virtual File Systems node, then select the appropriate VFS from the table and run the Make Read Only command from the drop-down menu of the action pane.

Description

The tools filestorage vfs makereadonly command makes the specified virtual file system read-only. This command can be used to reset the read status of a VFS that has previously been made read-write (for instance, a copy of a mirror VFS that was set to be read-write after the initial copy).

Options

-vfsname VFS_name

This is the name of the virtual file system that is to be made read-only.

Example

The following example makes a virtual file system named vfs.wasRW read-only.

spinserver::> tools filestorage vfs makereadonly -vfsname vfs.wasRW

tools filestorage vfs makereadwrite

Name

tools filestorage vfs makereadwrite -- Use the tools filestorage vfs makereadwrite command to make a virtual file system (VFS) read-write.

Synopsis

CLI:

tools filestorage vfs makereadwrite -vfsname VFS_name

GUI: Navigate to the Tools → File Storage → Virtual File Systems node, then select the appropriate VFS from the table and run the Make Read Write command from the drop-down menu of the action pane.

Description

The tools filestorage vfs makereadwrite command can be used to make certain virtual file systems read-write. VFSs that are by definition read-only, including clones, mirrors, and SpinShots, cannot be made read-write. However, full copies of read-only VFSs (for example, a copy of a mirror) can be made read-write.

Options

-vfsname VFS_name

This is the name of the virtual file system that is to be made read-write.

Example

The following example makes the virtual file system named vfs.wasRO read-write.

spinserver::> tools filestorage vfs makereadwrite -vfsname vfs.wasRO

tools filestorage vfs makereadwritemountpoints

Name

tools filestorage vfs makereadwritemountpoints -- Use the tools filestorage vfs makereadwritemountpoints command to create .readwrite mount points in a VFS after an upgrade of SpinFS 1.x to 2.x.

Synopsis

CLI:

tools filestorage vfs makereadwritemountpoints -vfsname VFS_name

GUI: Navigate to the Tools → File Storage → Virtual File Systems node, then select the appropriate VFS from the table and run the Make Read Write Mountpoints command from the drop-down menu of the action pane.

Description

The tools filestorage vfs makereadwritemountpoints command creates .readwrite mountpoints in a VFS. These mountpoints were introduced in SpinFS 2.0 and are required for the correct functioning of several SpinFS features.

Use this command only after upgrading from SpinFS 1.x to 2.x, or at the direction of Technical Support personnel.

Options

-vfsname VFS_name

This is the name of the virtual file system that is to have .readwrite mountpoints created in it.

Example

The following example creates .readwrite mountpoints in a VFS named vfs1 on a SpinServer that has been upgraded from SpinFS 1.x to 2.x.:

spinserver::> tools filestorage vfs makerreadwritemountpoints -vfsname vfs1

tools filestorage vfs makeroot

Name

tools filestorage vfs makeroot -- Use the tools filestorage vfs makeroot command to make a VFS the root VFS of the virtual server.

Synopsis

CLI:

tools filestorage vfs makeroot -vfsname VFS_name

GUI: Navigate to the Tools → File Storage → Virtual File Systems node, then select the appropriate VFS from the table and run the Make Root command from the drop-down menu of the action pane.

Description

The tools filestorage vfs makeroot command makes a VFS the root VFS of the virtual server. The VFS is renamed as root.virtual_server_name. For instance, if you run this command on a VFS named user that is located on a virtual server named VS1, the VFS is made the root VFS of the virtual server and is given the name root.VS1.

Options

-vfsname VFS_name

This is the name of the virtual file system that is to be made the root VFS of the virtual server.

Example

The following example makes a VFS named dept the root VFS of the virtual server:

spinserver::> tools filestorage vfs makeroot -vfsname dept

tools filestorage vfs migratefamily

Name

tools filestorage vfs migratefamily -- Use the tools filestorage vfs migratefamily command to migrate a VFS to another virtual server.

Synopsis

CLI:

tools filestorage vfs migratefamily -vfsname VFS_name -vserver virtual_server_name -force {true | false}

GUI: Navigate to the Tools → File Storage → Virtual File Systems node, then select the appropriate VFS from the table and run the Migrate Family command from the drop-down menu of the action pane. Enter the appropriate information into the table that is displayed, then click Migrate Family.

Description

The tools filestorage vfs migratefamily command migrates a VFS and all of its family VFSs (SpinShots and mirrors) to a different virtual server.

Caution:

Unless the VFS's original virtual server and its new virtual server are configured identically, with identical NIS domains, CIFS domains, and CIFS-to-NFS mappings, this command can result in extensive problems with permissions on the VFS's files, possibly causing loss of client access to data.

To prevent problems with permissions, NetApp recommends that you perform the following steps after migrating a VFS:

  1. Mount the VFS in a location that is accessible only to administrators.

  2. Specify the use of restricted ACLs on the VFS by running the filestorage vfs modify command with the -restrictedacl true parameter.

  3. Set the appropriate permissions on all files in the VFS by using chmod, chown, or other operating-system tools.

  4. If CIFS ACLs are to be used on the VFS, re-enable the use of ACLs by running the filestorage vfs modify command with the -restrictedacl false parameter.

  5. Unmount the VFS from its safe location, then mount it for access to users.

Options

-vfsname VFS_name

This is the name of the virtual file system that is to be migrated to a different virtual server along with its family VFSs.

-vserver virtual_server_name

This is the virtual server to which the VFS and its family VFSs are to be migrated.

-force {true | false}

This specifies whether the migration continues if an error is encountered. The default is false.

Example

The following example migrates a VFS named user.sam and all of its SpinShots and mirrors to a virtual server named vs2. The migration is not forced.

spinserver::> tools filestorage vfs migratefamily -vfsname user.sam -vsname vs2 -force false

tools filestorage vfs modify

Name

tools filestorage vfs modify -- Use the tools filestorage vfs modify command to modify the minimum quota, maximum quota, user type, domain, user, or group of an existing virtual file system.

Synopsis

CLI:

tools filestorage vfs modify -vfsname VFS_name [-usertype user_type] [-domain domain_name] [-user user_name] [-group group_name] [-qmin quota_minimum] [-qmax quota_maximum] [-freespacealarm free_space_alarm_threshold] [-rulesetname rule_set_name] [-virusscanrwvfs {true | false}] [-virusscanrovfs {true | false}] [-showspinshot {true | false}] [-restrictedacl {true | false}]

GUI: Navigate to the Tools → File Storage → Virtual File Systems node, then select the appropriate VFS from the table and run the Show command from the drop-down menu of the action pane. In the table that is displayed, make the appropriate modifications, then run the Modify command from the drop-down menu.

Description

The filestorage vfs modify command identifies a virtual file system by its name and modifies its settings.

Note: This command provides the same functionality as the filestorage vfs modify command. It is duplicated in the tools command node for easy access when you are working in the tools node.

Options

-vfsname VFS_name

This is the name of the virtual file system.

-usertype user_type

This parameter controls how SpinManager interprets the values of the -domain, -user, and -group parameters. Possible types include SPIN, NFS, CIFS, and NFS-Kerberos. Use the SPIN type if an NIS or CIFS domain is not configured or available. If you create an NFS or CIFS virtual server or VFS, an NIS or CIFS domain must already be configured on the SpinServer. The CIFS user type is used only for CIFS or mixed-security (NFS and CIFS) environments. If the parameter is set to NFS-Kerberos, you must specify a Kerberos realm name as the value of the -domain parameter and a Kerberos principal name as the value of the -user parameter; in this case, the value of the -group parameter is disregarded and can be omitted from the command. If the NFS-Kerberos user type is specified, the ownership of the VFS is assigned to the user that is mapped to the Kerberos principal name specified by the value of the -user parameter. The virtual server must have a NIS domain or other mapping mechanism (for instance, a pluggable authentication module) associated with it, and a Kerberos-NIS mapping that matches the Kerberos principal name must exist.

-domain domain_name

This is the name of the domain in which the user and group names are interpreted. If the -usertype parameter is set to SPIN, this is a numeric domain ID. If the parameter is set to NFS, this is the name of a NIS domain (configured by using the spinaccess nfs domains commands). If the parameter is set to CIFS, this is the name of a CIFS domain (configured by using the spinaccess cifs domains commands). If the parameter is set to NFS-Kerberos, this is the name of a Kerberos domain.

-user user_name

This is the user name or ID to be set as the owner of the root of the VFS. If the -usertype parameter is set to SPIN, this is a numeric user ID; if the parameter is set to NFS, CIFS, or NFS-Kerberos, this is the name of a user in the relevant domain.

-group group_name

This is the group name or ID to be set as the group owner of the root of the VFS. If the -usertype parameter is set to SPIN, this is a numeric group ID; if the parameter is set to NFS or CIFS, this is the name of a group in the relevant domain. If the parameter is set to NFS-Kerberos, this value is discarded and can be omitted from the command.

-qmin quota_minimum

This is the minimum quota specified in MB.

-qmax quota_maximum 

This is the maximum quota specified in MB.

-freespacealarm free_space_alarm_threshold

This is the percentage of VFS free space remaining before the free-space alarm is triggered. Possible values are integers from 1 to 50, or 0 to disable the free-space alarm.

-rulesetname rule_set_name

This specifies the name of the export rule set that is to be applied to the VFS.

-virusscanrwvfs {true | false}

This specifies whether virus scanning is enabled on read-write VFSs. The default is false.

-virusscanrovfs {true | false}

This specifies whether virus scanning is enabled on read-only VFSs (for instance, SpinShots and mirrors of a parent read-write VFS). The default is false.

-showspinshot {true | false}

This specifies whether the VFS's .spinshot directory is visible to clients. The default is true.

-restrictedacl {true | false}

This specifies whether CIFS ACLs are used (false) or not used (true) on files on the VFS. The default is false (that is, ACLs are used). If CIFS ACLs are not used, UNIX mode bits are the only permissions set on files on the VFS, and attempting to modify ACLs from a CIFS client results only in changes to the mode bits.

Example

The following example modifies the settings for the virtual file system named vfs1. The VFS belongs to a CIFS user with the user name chris. The domain is ENG and the group is ENG12. The user is given a minimum quota of 5000 MB and a maximum quota of 10000 MB. The free-space alarm is triggered when only 10 percent of free space remains on the VFS. An export rule set named rs1 is applied to the VFS. Virus scanning is enabled on the parent read-write VFS but disabled on any read-only VFSs (SpinShots or mirrors) of which this VFS is the parent. The .spinshot directory is not visible to clients. CIFS ACLs are not used on the VFS.

spinserver::> tools filestorage vfs modify -vfsname vfs1 -usertype CIFS -domain ENG -user chris -group ENG12 -qmin 5000 -qmax 10000 -freespacealarm 10 -rulesetname rs1 -virusscanrwvfs true -virusscanrovfs false  -showspinshot false -restrictedacl true

tools filestorage vfs promote

Name

tools filestorage vfs promote -- Use the tools filestorage vfs promote command to promote a mirror, a SpinShot, or a SpinShot of a mirror to the parent read-write VFS.

Synopsis

CLI:

tools filestorage vfs promote -vfsname VFS_name

GUI: Navigate to the Tools → File Storage → Virtual File Systems node, then select the appropriate VFS from the table and run the Promote command from the drop-down menu of the action pane.

Description

The tools filestorage vfs promote command promotes a read-only VFS such as a mirror, a SpinShot, or a SpinShot of a mirror to the parent read-write VFS. This command deletes the current read-write VFS in the family and any SpinShots in the family that have a data version more recent than the data version of the promoted VFS.

Options

-vfsname VFS_name

This is the name of the virtual file system that is to be promoted.

Example

The following example promotes a virtual file system named vfs1.mirror2 as the parent read-write VFS for its family.

spinserver::> tools filestorage vfs promote -vfsname vfs1.mirror2

tools filestorage vfs rename

Name

tools filestorage vfs rename -- Use the tools filestorage vfs rename command to rename a read-write virtual file system (VFS).

Synopsis

CLI:

tools filestorage vfs rename -vfsname VFS_name -newvfsname new_VFS_name -forceunmount {true | false}

GUI: Navigate to the Tools → File Storage → Virtual File Systems node, then select the appropriate VFS from the table and run the Rename command from the drop-down menu of the action pane. Enter the appropriate value into the table that is displayed and click Rename.

Description

The tools filestorage vfs rename command renames a read-write VFS. The read-write VFS cannot have any associated mirrors. When a VFS is renamed, be sure to unmount it and remount it so that its parent VFS refers to it by its new name. Use either the filestorage vfs unmount or tools filestorage vfs forceunmount command to unmount a VFS, and the filestorage vfs mount command to remount it. NetApp recommends that you also unmount and remount any VFSs that are mounted under the renamed VFS.

In the event that the parent VFS is offline or otherwise inaccessible when a VFS is renamed, specify a value of false for the -unmount option.

Options

-vfsname VFS_name

This is the name of the virtual file system that is to be renamed.

-newvfsname new_VFS_name

This is the new name of the VFS.

-forceunmount {true | false}

This specifies whether to force the renaming of the VFS in the event that unmounting the VFS with its original name fails. The default is false.

Example

The following example renames a virtual file system named old.vfs as new.vfs. The VFS is unmounted before it is renamed.

spinserver::> tools filestorage vfs rename -vfsname old.vfs -newvfsname new.vfs -unmount true

tools filestorage vfs setoffline

Name

tools filestorage vfs setoffline -- Use the tools filestorage vfs setoffline command to take a VFS offline.

Synopsis

CLI:

tools filestorage vfs setoffline -vfsname VFS_name

GUI: Navigate to the Tools → File Storage → Virtual File Systems node, then select the appropriate VFS from the table and run the Set Offline command from the drop-down menu of the action pane.

Description

The tools filestorage vfs setoffline command takes a VFS offline; that is, makes it inaccessible to client access. Taking a VFS offline makes it easier to perform maintenance and disaster-recovery tasks. After a VFS is taken offline, use the tools filestorage vfs setonline command to put it online.

Options

-vfsname VFS_name

This is the name of the virtual file system that is to be taken offline.

Example

The following example takes a VFS named dept.sales offline:

spinserver::> tools filestorage vfs setoffline -vfsname dept.sales

tools filestorage vfs setonline

Name

tools filestorage vfs setonline -- Use the tools filestorage vfs setonline command to put a VFS online.

Synopsis

CLI:

tools filestorage vfs setonline -vfsname VFS_name

GUI: Navigate to the Tools → File Storage → Virtual File Systems node, then select the appropriate VFS from the table and run the Set Online command from the drop-down menu of the action pane.

Description

The tools filestorage vfs setonline command puts an offline VFS online; that is, makes it accessible to client access.

Options

-vfsname VFS_name

This is the name of the virtual file system that is to be put online.

Example

The following example puts a VFS named dept.sales online:

spinserver::> tools filestorage vfs setonline -vfsname dept.sales

tools filestorage vfs show

Name

tools filestorage vfs show -- Use the tools filestorage vfs show command to display configuration details of a virtual file system.

Synopsis

CLI:

tools filestorage vfs show [-vfsname VFS_name]

GUI: Navigate to the Tools → File Storage → Virtual File Systems node. To display information about a specific VFS, select it from the table and run the Show command from the drop-down menu of the action pane.

Description

The filestorage vfs show command identifies a virtual file system by its virtual file system name. When identification of a specific VFS is made, the following information is displayed about the virtual file system. A subset of this information is displayed if you run the command without using the -vfsname parameter to specify a VFS name.

When issued without the -vfsname parameter, the filestorage vfs show command lists only read-write VFSs. To display a list of all VFSs on a SpinServer system, including read-only VFSs such as SpinShots and mirrors, use the filestorage vfs show-all command.

Note: This command provides the same functionality as the filestorage vfs show command. It is duplicated in the tools command node for easy access when you are working in the tools node.

Options

[-vfsname VFS_name]

This is the virtual file system name.

Example

The following example displays information about all read-write virtual file systems.

spinserver::> tools filestorage vfs show 
VFS                  Fam MaxQ (MB)  Used (MB)   Storage   SP Avail (MB) Status
                     Siz                          Pool


root.vs0             1   10         1          pool0      47806         online
root.vs1             1   10         1          pool1      63883         online
test                 1   10         1          pool0      47806         online
test.cp              1   10         1          pool0      47806         online
vs0pool0_10          1   10         1          pool0      47806         online
vs0pool0_11          1   10         1          pool0      47806         online
vs0pool0_12          1   10         1          pool0      47806         online
vs0pool0_13          1   10         1          pool0      47806         online
vs0pool0_14          1   10         1          pool0      47806         online
vs0pool0_15          1   10         1          pool0      47806         online
vs0pool0_16          1   10         1          pool0      47806         online

The following example displays detailed information about the virtual file system named root.vs0.

spinserver::> tools filestorage vfs show -vfsname root.vs0
   VFS                              root.vs0                                
   Family Name                      root.vs0                                
   Family Size                      2                                       
   Virtual Server                   vs0                                     
   VFS ID                           1024                                    
   Type                             read-write                              
   Create Time                      7/14/03 11:54 AM                        
   Mounted From                     root.vs0                                
   Mount Type
   Mount Path                       /                                       
   Minimum Quota (MB)               10                                      
   Maximum Quota (MB)               10                                      
   Free Space Alarm Threshold (%)   0                                       
   Used (MB)                        1                                       
   Storage Pool                     pool0 
   SP Avail (MB)                    129690                                  
   User Type of root FID            SPIN                                    
   Domain of root FID               0                                       
   User of root FID                 0                                       
   Group of root FID                0                                       
   Export Ruleset Name              default_ruleset                         
   VirusScan for R-W                true                                    
   VirusScan for R-O                true                                    
   Show Spinshot Directory          false
   Status                           online                                  
   Status Error

tools filestorage vfs show-access

Name

tools filestorage vfs show-access -- Use the tools filestorage vfs show-access command to display information about export rule sets for one or more virtual file systems (VFSs).

Synopsis

CLI:

tools filestorage vfs show-access -vfsname VFS_name

GUI: Navigate to the Tools → File Storage → Virtual File Systems node, then select the appropriate VFS from the table that is displayed and run the Show command from the drop-down menu of the action pane.

Description

The tools filestorage vfs show-access command displays information about export rule sets for one or more VFSs.

Note: This command provides the same functionality as the filestorage vfs show-access command. It is duplicated in the tools command node for easy access when you are working in the tools node.

Options

-vfsname VFS_name

This is the virtual file system name.

Example

The following example displays the export rule set information for all VFSs.

spinserver::> tools filestorage vfs show-access 
        VFS             VFS ID       Export   
                                    Ruleset   
                                      Name    

vfs1                    1027        rs1
vfs2                    2023        rs1
vfs3                    2024        none

tools filestorage vfs show-all

Name

tools filestorage vfs show-all -- Use the tools filestorage vfs show-all command to display a listing of all virtual file systems (VFSs), including read-only VFSs such as SpinShots and mirrors.

Synopsis

CLI:

tools filestorage vfs show-all

GUI: Navigate to the Tools → File Storage → Virtual File Systems node, then click Show All in the top bar of the action pane.

Description

The tools filestorage vfs show-all command displays all VFSs, both read-write and read-only.

Note: This command provides the same functionality as the filestorage vfs show-all command. It is duplicated in the tools command node for easy access when you are working in the tools node.

Options

There are no parameters for this command.

Example

The following example displays all VFSs.

spinserver::> tools filestorage vfs show-all 
VFS                  Fam MaxQ (MB)  Used (MB)   Storage   SP Avail (MB) Status
                     Siz                          Pool


root.vs0             1   10         1          pool0      47806         online
root.vs1             1   10         1          pool1      63883         online
vs0pool0_11          1   10         1          pool0      47806         online
vs0pool0_12          1   10         1          pool0      47806         online
vs0pool0_13          1   10         1          pool0      47806         online
vs0pool0_14          1   10         1          pool0      47806         online
vs0pool0_15          1   10         1          pool0      47806         online
vs0pool0_16          1   10         1          pool0      47806         online
vs0pool0_17          1   10         1          pool0      47806         online
vs0pool0_18          1   10         1          pool0      47806         online
vs0pool0_19          1   10         1          pool0      47806         online
vs0pool0_20          1   10         1          pool0      47806         online
vs0pool0_21          1   10         1          pool0      47806         online
vs0pool0_22          1   10         1          pool0      47806         online
vs0pool0_23          1   10         1          pool0      47806         online

tools filestorage vfs show-family

Name

tools filestorage vfs show-family -- Use the tools filestorage vfs show-family command to display the read-only virtual file systems (VFSs), such as SpinShots and mirrors, that are associated with a read-write virtual file system.

Synopsis

CLI:

tools filestorage vfs show-family -vfsname VFS_name

GUI: Navigate to the Tools → File Storage → Virtual File Systems node, then select the appropriate VFS from the table that is displayed and run the Show Family command from the drop-down menu of the action pane.

Description

The tools filestorage vfs show-family command displays the following information about the read-only VFSs that are associated with a read-write VFS:

Note: This command provides the same functionality as the filestorage vfs show-family command. It is duplicated in the tools command node for easy access when you are working in the tools node.

Options

-vfsname VFS_name

This is the virtual file system name.

Example

The following example displays the SpinShots and mirrors for a virtual file system named san.

spinserver::> tools filestorage vfs show-family -vfsname vfs1
VFS        Type        Mount Path         Create Time            Storage      Status
                                                                  Pool   
                                  
san.67     spinshot   .spinshot/hourly   09/22/2004 8:58 AM       pool0      online 
san.77     spinshot   .spinshot/hourly   09/22/2004 6:23 AM       pool0      online 
san.16     spinshot   .spinshot/weekly   09/12/2004 12:44 AM      pool0      online 
san.m1     mirror     /san               09/22/2004 9:30 AM       pool1      online 
san        read-write /san               07/06/2004 1:32 PM       pool0      online 
san.23     spinshot   .spinshot/hourly   09/22/2004 11:28 AM      pool0      online 
san.19     spinshot   .spinshot/daily    09/22/2004 12:38 AM      pool0      online 
san.m3     mirror     /san               09/22/2004 9:30 AM       pool19     online 
san.m0     mirror     /san               09/22/2004 9:30 AM       pool0      online 
san.m5     mirror     /san               09/22/2004 9:30 AM       pool15     online 
san.m4     mirror     /san               09/22/2004 9:30 AM       pool14     online 
san.36     spinshot   .spinshot/daily    09/15/2004 12:37 AM      pool0      online 
san.m2     mirror     /san               09/22/2004 9:31 AM       pool99     online 

tools filestorage vfs show-mount

Name

tools filestorage vfs show-mount -- Use the tools filestorage vfs show-mount command to display mount-path information for a specific virtual file system or for all virtual file systems.

Synopsis

CLI:

tools filestorage vfs show-mount [-vfsname VFS_name]

GUI: Navigate to the Tools → File Storage → Virtual File Systems node, then select the appropriate VFS from the table that is displayed and run the Show command from the drop-down menu of the action pane.

Description

The tools filestorage vfs show-mount command can be used without the -vfsname parameter to display mount path information about all VFSs in the system or with the -vfsname parameter to display mount path information about a specific VFS. If the VFS name is specified, this command displays the same information as the filestorage vfs show command for the specified VFS name.

Note: This command provides the same functionality as the filestorage vfs show-mount command. It is duplicated in the tools command node for easy access when you are working in the tools node.

Options

[-vfsname VFS_name]

This is the virtual file system name.

Example

The following example displays mount-path information for all virtual file systems.

spinserver::> tools filestorage vfs show-mount 
VFS       VFS ID    Mount Type Mounted From  Mount Path   Use    Storage    SP Avail                                                           (MB)     Pool      (MB) 
root.vs0   305918                  root.vs0     /           1      sp0       118326       
sp0.ptar0  1255104      context    root.vs0     /sp0.ptar0  67     sp0       118326       
sp0.ptar1  1255105      context    root.vs0     /sp0.ptar1  67     sp0       118326       
sp0.ptar10 1255114      context    root.vs0     /sp0.ptar10 67     sp0       118326       
sp0.ptar11 1255115      context    root.vs0     /sp0.ptar11 67     sp0       118326       
sp0.ptar12 1255116      context    root.vs0     /sp0.ptar12 67     sp0       118326       
sp0.ptar13 1255117      context    root.vs0     /sp0.ptar13 67     sp0       118326       
sp0.ptar14 1255118      context    root.vs0     /sp0.ptar14 67     sp0       118326       
sp0.ptar15 1255119      context    root.vs0     /sp0.ptar15 67     sp0       118326

tools filestorage vfs show-vs

Name

tools filestorage vfs show-vs -- Use the tools filestorage vfs show-vs command to display virtual server information for a specific VFS or for all VFSs.

Synopsis

CLI:

tools filestorage vfs show-vs [-vfsname VFS_name]

GUI: Navigate to the Tools → File Storage → Virtual File Systems node, then select the appropriate VFS from the table that is displayed and run the Show command from the drop-down menu of the action pane.

Description

The tools filestorage vfs show-vs command can be used without the -vfsname parameter to display the virtual server information about all VFSs in the system or with the -vfsname parameter to display information about a specific VFS. If the VFS name is specified, this command displays the same information as the vfs filestorage show-mount command for the specified VFS.

Note: This command provides the same functionality as the filestorage vfs show-vs command. It is duplicated in the tools command node for easy access when you are working in the tools node.

Options

[-vfsname VFS_name]

This is the name of the virtual file system.

Example

The following example displays the virtual server information for all virtual file systems.

spinserver::> tools filestorage vfs show-vs 
    VFS        VServer    Storage    VFS ID
                            Pool

m.vfs1       vs0          pool1    1073742857
m.vfs1.32004 vs0          pool1    32004
m.vfs1.32007 vs0          pool1    32007
root.vs0     vs0          pool0    1024
vfs1         vs0          pool0    1033

RAID Tools Commands

Name

RAID Tools Commands -- 

The tools raid node includes the sets subnode.


RAID Sets Tools Commands

Name

RAID Sets Tools Commands -- 

The tools raid sets subnode includes the following commands:


tools raid sets delete

Name

tools raid sets delete -- Use the tools raid sets delete command to delete a RAID set.

Synopsis

CLI:

tools raid sets delete -deviceid device_ID

GUI: Navigate to the Tools → RAID → RAID Sets node, then select the appropriate RAID set from the table and run the Delete command from the drop-down menu of the action pane.

Description

The tools raid sets delete command identifies a RAID set by the device ID assigned to it. After identification is made, the RAID set is removed from the RAID subsystem.

Note: This command provides the same functionality as the raid sets delete command. It is duplicated in the tools command node for easy access when you are working in the tools node.

Options

-deviceid device_ID

The device identification is in the format rsubsystem_numbersraidset_number, where subsystem_number indicates the RAID subsystem and raidset_number indicates the specific RAID set.

Example

The following command example identifies RAID set r0s0 and removes it from the RAID subsystem.

spinserver::> tools raid sets delete -deviceid r0s0 

tools raid sets forcedelete

Name

tools raid sets forcedelete -- Use the tools raid sets forcedelete command to forcibly delete a RAID set.

Synopsis

CLI:

tools raid sets forcedelete -deviceid device_ID

GUI: Navigate to the Tools → Raid Sets node, then select the appropriate RAID set from the table and run the Force Delete command from the drop-down menu of the action pane.

Description

The tools raid sets forcedelete command forcibly deletes a RAID set.

Options

-deviceid device_ID

This specifies the device ID of the RAID set that is to be deleted.

Example

The following example forcibly deletes a RAID set with the device ID r0s0:

spinserver::> tools raid sets forcedelete -deviceid r0s0

tools raid sets new

Name

tools raid sets new -- Use the tools raid sets new command to create a RAID set.

Synopsis

CLI:

tools raid sets new -raidlevel { 0 | 1 | 3 | 5 | 0+1 } -stripsize { 8 | 16 | 32 | 64 } -writecacheenabled {true | false} -status RAID_status -disks [list_of_disks]

GUI: Navigate to the Tools → RAID → Sets node, then click New in the top bar of the action pane. Enter the appropriate values into the table that is displayed and click Create.

Description

The raid sets new command creates a RAID set conforming to the values specified in the command options.

Note: This command provides the same functionality as the raid sets new command. It is duplicated in the tools command node for easy access when you are working in the tools node.

Options

-raidlevel { 0 | 1 | 3 | 5 | 0+1 }

The RAID set level is the type of RAID on the RAID set. The following values are supported: 0, 1, 3, 5, and 0+1. The default is 5.

-stripsize { 8 | 16 | 32 | 64 }

The default RAID set strip size is 32 KB. Other possible sizes are 8 KB, 16 KB, or 64 KB. A RAID strip is a piece of a single disk that is used for data storage. A RAID stripe is a set of the corresponding strips from all of the disks in a RAID set. The RAID strip size must match the RAID strip size that is currently set on the RAID controller.

-writecacheenabled {true | false}

This specifies whether the write cache is enabled. The default is true.

-status RAID_status 

The RAID set status must be set to Online to enable immediate access to the RAID set after it has been created. The default is Online.

Note: Setting the status to Offline creates a RAID set but does not immediately enable its use in a storage pool.

-disks [list_of_disks]

The list of disks to be included in the RAID set is a square-bracketed, comma-separated list of disk IDs, each in the format rsubsystem_numberddisk_number, where subsystem_number indicates the RAID subsystem and disk_number indicates the specific disk drive. The maximum number of disks in a single RAID set is 16. By default, all unused disk drives (up to 16) are included. If you are using the CLI and press the Tab key after the -disks parameter, all unused disk drives (up to 16) are automatically listed.

Note: A RAID set of level 0 must have at least two (2) disks.

A RAID set of level 1 must have exactly two (2) disks.

A RAID set of level 3 must have at least three (3) disks.

A RAID set of level 5 must have at least three (3) disks.

A RAID set of level 0+1 must have at least four (4) disks.

Example

The following command example creates RAID set named r0s0, of level 5, using 14 disks named r0d0 through r0d13.

spinserver::> tools raid sets new -raidlevel 5 -stripsize 8 -cachelinesize 8 -writecacheenabled false -status Online -disks [r0d0, r0d1, r0d2, r0d3, r0d4, r0d5, r0d6, r0d7, r0d8, r0d9, r0d10, r0d11, r0d12, r0d13]

tools raid sets show

Name

tools raid sets show -- The tools raid sets show command displays information about the RAID sets in a RAID subsystem.

Synopsis

CLI:

tools raid sets show [-deviceid device_ID]

GUI: Navigate to the Tools → RAID → Sets node. To display information about a specific RAID set, select it from the table and run the Show command from the drop-down menu in the action pane.

Description

The tools raid sets show command identifies a specific RAID set or all RAID sets on the RAID subsystem. The command displays the following information:

Note: This command provides the same functionality as the raid sets show command. It is duplicated in the tools command node for easy access when you are working in the tools node.

Options

[-deviceid device_ID]

The device identification is in the format rsubsystem_numbersraidset_number, where subsystem_number indicates the RAID subsystem and raidset_number indicates the specific RAID set.

Example

The following example displays information about all RAID sets.

spinserver::> tools raid sets show 
Device  RAID   Logical   Phys Size  Initialized  #   Status
  ID     Lvl     Size                           Disk

r0s0    5     138848     173560     true        5    Online
r0s1    5     138848     173560     true        5    Online
r0s2    5     138848     173560     true        5    Online
r1s0    5     138848     173560     true        5    Online
r1s1    5     138848     173560     true        5    Online
r1s2    5     138848     173560     true        5    Online
r1s3    5     138848     173560     true        5    Online
r1s4    5     138848     173560     true        5    Online
r1s5    5     138848     173560     true        5    Online

The following command example displays information about RAID set r0s0.

spinserver::> tools raid sets show -deviceid r0s0
   Device ID              r0s0
   RAID Level             5
   Logical Size (MB)      138848
   Physical Size (MB)     173560
   Strip Size (KB)        16
   Cache Line Size (KB)   16
   Initialized?           true
   Write Cache Enabled?   false
   Status                 Online
   # Disks                5
   Disks                  r0d2, r0d6, r0d1, r0d5, r0d9
   LongOp In Progress     None

tools raid sets show-disks

Name

tools raid sets show-disks -- Use the tools raid sets show-disks command to display the IDs of the disks that comprise a RAID set.

Synopsis

CLI:

tools raid sets show-disks [-deviceid device_ID]

GUI: Navigate to the Tools → RAID → Sets node, then select the appropriate RAID set from the table and run the Show command from the drop-down menu of the action pane.

Description

The tools raid sets show-disks command identifies a RAID set in the RAID subsystem with the device ID specified, or all RAID sets in the system if the -deviceid parameter is not used. The command displays a list of all disks that comprise the RAID set or sets.

Note: This command provides the same functionality as the raid sets show-disks command. It is duplicated in the tools command node for easy access when you are working in the tools node.

Options

[-deviceid device_ID]

The device identification is in the format rsubsystem_numbersraidset_number, where subsystem_number indicates the RAID subsystem and raidset_number indicates the specific RAID set.

Example

The following command example displays informations about the disks that comprise the RAID sets.

spinserver::> tools raid sets show-disks 
Device ID   #                    Disks
           Disk

r0s0       5    r0d2, r0d6, r0d1, r0d5, r0d9
r0s1       5    r0d10, r0d14, r0d18, r0d13, r0d17
r0s2       5    r0d22, r0d26, r0d21, r0d25, r0d29
r1s0       5    r1d66, r1d70, r1d74, r1d78, r1d82
r1s1       5    r1d86, r1d90, r1d65, r1d69, r1d73
r1s2       5    r1d77, r1d81, r1d85, r1d89, r1d93
r1s3       5    r1d34, r1d38, r1d33, r1d37, r1d41
r1s4       5    r1d42, r1d46, r1d50, r1d45, r1d49
r1s5       5    r1d54, r1d58, r1d53, r1d57, r1d61

Storage Tools Commands

Name

Storage Tools Commands -- 

The tools storage node includes the following subnodes:


Storage Pools Tools Commands

Name

Storage Pools Tools Commands -- 

The tools storage pools node includes the following subnodes:


tools storage pools forceaddpassive

Name

tools storage pools forceaddpassive -- Use the tools storage pools forceaddpassive command to forcibly add a passive secondary server to a storage pool.

Synopsis

CLI:

tools storage pools forceaddpassive -deviceid device_ID -passivesec spinserver -priority priority

GUI: Navigate to the Tools → Storage Pools → Storage Pools node, then select the appropriate storage pool from the table and run the Force Add Passive Secondary command from the drop-down menu of the action pane. Enter the appropriate values into the table that is displayed, then click Force Add Passive Secondary.

Description

The tools storage pools forceaddpassive command forcibly adds a passive secondary server to a storage pool. This is useful in disaster-recovery situations in which a storage pool must be physically moved from one SpinServer to another within a cluster.

Options

-deviceid device_ID

This specifies the device ID of the storage pool that is to be deleted.

-passivesec spinserver

This specifies the name of the SpinServer that is to be added as a passive secondary server.

-priority priority

This specifies the takeover priority of the passive secondary server.

Example

The following example forcibly adds a SpinServer named Server2 as passive secondary server to a storage pool with the device ID sp0. The priority of the new passive secondary server is set to 1 (first priority):

spinserver::> tools storage pools forceaddpassive -deviceid sp0 -passivesec Server2 -priority 1

tools storage pools forcedelete

Name

tools storage pools forcedelete -- Use the tools storage pools forcedelete command to forcibly delete a storage pool.

Synopsis

CLI:

tools storage pools forcedelete -deviceid device_ID

GUI: Navigate to the Tools → Storage Pools → Storage Pools node, then select the appropriate storage pool from the table and run the Force Delete command from the drop-down menu of the action pane.

Description

The tools storage pools forcedelete command forcibly deletes a storage pool.

Options

-deviceid device_ID

This specifies the device ID of the storage pool that is to be deleted.

Example

The following example forcibly deletes a storage pool with the device ID sp0:

spinserver::> tools storage pools forcedelete -deviceid sp0

tools storage pools forceoffline

Name

tools storage pools forceoffline -- Use the tools storage pools forceoffline command to forcibly take a storage pool offline.

Synopsis

CLI:

tools storage pools forceoffline -deviceid device_ID

GUI: Navigate to the Tools → Storage Pools → Storage Pools node, then select the appropriate storage pool from the table and run the Force Offline command from the drop-down menu of the action pane.

Description

The tools storage pools forceoffline command forcibly takes a storage pool offline.

Options

-deviceid device_ID

This specifies the device ID of the storage pool that is to be taken offline.

Example

The following example forcibly takes offline a storage pool with the device ID sp0:

spinserver::> tools storage pools forceoffline -deviceid sp0

tools storage pools forcetakeover

Name

tools storage pools forcetakeover -- Use the tools storage pools forcetakeover command to force a SpinServer to take over as the primary server for a storage pool.

Synopsis

CLI:

tools storage pools forcetakeover -deviceid device_ID -newprimary new_primary

GUI: Navigate to the Tools → Storage Pools → Storage Pools node, then select the appropriate storage pool from the table and run the Force Takeover command from the drop-down menu of the action pane. Enter the appropriate values in the table that is displayed, then click Force Takeover.

Description

The tools storage pools forcetakeover command forces a SpinServer to take over as the primary server for a storage pool. This can be done only when there is currently no active primary for the storage pool.

Options

-deviceid device_ID

This is the device ID of the storage pool.

-newprimary new_primary

This is the name of the active secondary that is to take over as the primary for the storage pool.

Example

The following example forces a secondary named backupServer to take over as the primary server for a storage pool named sp0.

spinserver::> tools storage pools forcetakeover -deviceid sp0 -newprimary backupServer

tools storage pools show

Name

tools storage pools show -- Use the tools storage pools show command to display information about one or more storage pools known to a SpinServer.

Synopsis

CLI:

tools storage pools show [-deviceid device_ID]

GUI: Navigate to the Tools → Storage Pools → Storage Pools node. To display information about a specific storage pool, select it from the table and run the Show command from the drop-down menu of the action pane.

Description

The tools storage pools show command displays information about a storage pool if the -deviceid parameter is specified and information about all storage pools if the parameter is not specified. After identification of the storage pool or pools has been made, the following information is displayed. A subset of this information is displayed if the -deviceid parameter is not specified.

Note: This command provides the same functionality as the storage pools show command. It is duplicated in the tools command node for easy access when you are working in the tools node.

Options

[-deviceid device_ID]

This is the device ID of the storage pool for which to display specific information.

Example

The following command example displays information about all storage pools.

spinserver::> tools storage pools show 
Device ID   Status   Size (MB)    Available    Use%   # VFS   Primary Server
                                     (MB)

sp0        online   833316       54571        93.5%  470     Server2
sp1        online   416543       360721       13.4%  5       Server2

The following example displays information about a storage pool named sp0.

spinserver::> tools storage pools show -deviceid sp0
   Device ID                        sp0                                     
   UUID                             66b1714033b80b00336b6d696e370000        
   Status                           online                                  
   Layout                           stripe                                  
   Group Size (MB)                  512                                     
   Size (MB)                        138848                                  
   Used                             20336                                   
   Avail                            118512                                  
   Use%                             14.6%                                   
   Free Space Alarm Threshold (%)   1                                       
   # VFS                            172                                     
   Storage Units Present            su0                                     
   Storage Units Required           su0                                     
   Max # Actives                    1                                       
   Home Server                      Server1                                  
   Primary Server                   Server1                                  
   Active Servers                   Server2                                    
   Passive Servers
   Pool Version                     17321                                   
   NVRAM Version                    17321                                   
   Server Priorities                Server2:1, Server1:64                      

Storage Units Tools Commands

Name

Storage Units Tools Commands -- 

The tools storage units subnode includes the following commands:


tools storage units erase

Name

tools storage units erase -- Use the tools storage units erase command to erase all data on a storage unit.

Synopsis

CLI:

tools storage units erase -deviceid device_ID -zerofill {true | false}

GUI: Navigate to the Tools → Storage Pools → Storage Units node, then select the appropriate storage pool from the table and run the Erase command from the drop-down menu of the action pane. Enter the appropriate values in the table that is displayed, then click Erase.

Description

The tools storage units erase command erases all data on a storage unit. This command is useful for deleting data from an evaluation system before redeploying it as a production system.

Options

-deviceid device_ID

This is the device ID of the storage unit that is to be erased.

-zerofill {true | false}

This specifies whether the storage unit is to filled with zeroes. The default is false.

Example

The following example erases all data from a storage unit named su0. The storage unit is not filled with zeroes.

spinserver::> tools storage units erase -deviceid su0 -zerofill false

tools storage units modify

Name

tools storage units modify -- Use the tools storage units modify command to set the primary host channel for a storage unit.

Synopsis

CLI:

tools storage pools modify -deviceid device_ID -primaryhostchannel primary_host_channel -desiredphc {Auto | 0 | 1 | 2 | 3}

GUI: Navigate to the Tools → Storage Pools → Storage Units node, then select the appropriate storage pool from the table and run the Show command from the drop-down menu of the action pane. Make the appropriate changes to the table that is displayed, then run the Modify command from the drop-down menu.

Description

The tools storage units modify command sets the primary host channel and the desired primary host channel for a storage unit.

Note: This command provides the same functionality as the storage units modify command. It is duplicated in the tools command node for easy access when you are working in the tools node.

Options

-deviceid device_ID

This is the device ID of the storage unit.

-primaryhostchannel primary_host_channel

This is the primary host channel of the storage unit. Possible values are 0 and 1.

-desiredphc {Auto | 0 | 1 | 2 | 3}

This specifies the desired primary host channel for the Fibre Channel connection between the SpinServer and the storage unit. Acceptable values for the parameter include Auto, 0, 1, 2, and 3. If the value is specified as Auto, the SpinServer uses the primary channel that is selected by the Fibre Channel device; if the value is specified as 0, 1, 2, or 3, the SpinServer uses that value as the primary channel. The default value for a new storage unit is Auto.

Example

The following command example sets the storage unit named su0 to use primary host channel 1, and sets the desired primary host channel to Auto:

spinserver::> tools storage units modify -deviceid su0 -primaryhostchannel 1 -desiredphc Auto

tools storage units show

Name

tools storage units show -- Use the tools storage units show command to display information about all storage units located on a SpinServer.

Synopsis

CLI:

tools storage units show [-deviceid device_ID]

GUI: Navigate to the Tools → Storage Pools → Storage Units node. To display information about a specific storage unit, select it from the table and run the Show command from the drop-down menu of the action pane.

Description

The tools storage units show command displays information about all storage units if no parameter is specified or information about one storage unit if the parameter is specified. After identification of the storage unit or units has been made, the following information is displayed by the system. A subset of this information is displayed if the -deviceid parameter is not specified.

Note: This command provides the same functionality as the storage units show command. It is duplicated in the tools command node for easy access when you are working in the tools node.

Options

[-deviceid device_ID]

This is the device identification of the storage unit is the integer device ID as seen by the Fibre Channel driver.

Example

The following example displays information about all storage units.

spinserver::> tools storage units show 
Device  World Wide Name  LUN  RAID  FCD  Status  Damaged? Error? Size 
  ID                           Set  ID                           (GB) 
                                                                      
su0     20000080e512555e 0    r0s0  0   Online   false    false  136  

The following command example displays information about a storage unit named su0.

spinserver::> tools storage units show -deviceid su0
   Device ID                       su0
   World Wide Name                 20000080e511632b
   LUN                             0
   FCD ID                          0
   D-Function Device ID            7
   Primary Host Channel Status     connected
   Primary Host Channel            1
   Primary Loop ID                 133
   Secondary Host Channel Status   connected
   Secondary Host Channel          0
   Secondary Loop ID               132
   RAID Set                        r1s0
   Type                            RAID 5
   Vendor                          SPINNET
   Product                         1316-06v2
   Revision                        5785
   Status                          Online
   Damaged?                        false
   Error?                          false
   Last Error Code                 0
   Error Description               success
   Size (GB)                       136

System Tools Commands

Name

System Tools Commands -- 

The tools system rootfilesystem node includes the following commands:


tools system rootfilesystem forceupgrade

Name

tools system rootfilesystem forceupgrade -- Use the tools system rootfilesystem forceupgrade command to force a software upgrade.

Synopsis

CLI:

tools system rootfilesystem forceupgrade -ssid spinserver -name file_system_name -installurl {cdrom | file:file_name | ftp:FTP_site}

GUI: Navigate to the Tools → System → Root File System node, then select the appropriate file system from the table and run the Force Upgrade command from the drop-down menu of the action pane. Enter the appropriate values in the table that is displayed, then click Force Upgrade.

Description

The tools system rootfilesystem forceupgrade command forces a software upgrade on a specified root file system. Use this command only at the direction of support personnel.

Options

-ssid spinserver

This specifies the SpinServer.

-name file_system_name

This specifies the name of the file system that is to be forcibly upgraded. Possible values are ROOT and ALTROOT. The default is ALTROOT.

-installurl {cdrom | file:file_name | ftp:FTP_site}

This specifies the location (CD-ROM, file, or FTP site) that contains the software upgrade. If cdrom is specified, the SpinServer automatically mounts and unmounts the CD-ROM as part of the upgrade process.

Example

The following example forcibly upgrades the software on the ALTROOT partition of a SpinServer named Server1 from a CD-ROM.

spinserver::> tools system rootfilesystem forceupgrade -ssid Server1 -name ALTROOT -installurl cdrom

tools system rootfilesystem modify

Name

tools system rootfilesystem modify -- Use the tools system rootfilesystem modify command to set the synchronization value for a SpinServer's root file system at the next system restart.

Synopsis

CLI:

tools system rootfilesystem modify -ssid spinserver -name file_system_name -synconreboot {NONE | CONFIGURATION | FILESYSTEM}

GUI: Navigate to the Tools → System → Root File System node, then select the appropriate root file system from the table and run the Show command from the drop-down menu of the action pane. Enter the appropriate values into the table that is displayed, then run the Modify command from the drop-down menu.

Description

The tools system rootfilesystem modify command sets the synchronization value for a SpinServer's root file system at the next system restart.

Note: This command provides the same functionality as the system rootfilesystem modify command. It is duplicated in the tools command node for easy access when you are working in the tools node.

Options

-ssid spinserver

This specifies SpinServer whose root file system is to be synchronized.

-name file_system_name

This specifies the root file-system partition on which the synchronization is to take place. Possible values are ROOT and ALTROOT.

-synconreboot {NONE | CONFIGURATION | FILESYSTEM}

This specifies the synchronization value for the root file system the next time the SpinServer is restarted. Possible values include NONE, for no synchronization; CONFIGURATION, for configuration synchronization; and FILESYSTEM, to synchronize the two root file systems.

After a system restart, this setting is automatically reset to NONE.

Example

The following example modifies the root file-system partition named ROOT on a SpinServer named Server1 so that it synchronizes the configuration of the root file system the next time the SpinServer is restarted:

spinserver::> tools system rootfilesystem modify -ssid Server1 -name ROOT -synconreboot CONFIGURATION

tools system rootfilesystem show

Name

tools system rootfilesystem show -- Use the tools system rootfilesystem show command to display information about a SpinServer's root file-system partitions.

Synopsis

CLI:

tools system rootfilesystem show [-ssid spinserver -name file_system_name]

GUI: Navigate to the Tools → System → Root File System node. To display information about a specific root file system, select it from the table and run the Show command from the drop-down menu of the action pane.

Description

The tools system rootfilesystem show command displays information about a SpinServer's root file-system partitions. Use the command with the -ssid and -name parameters to display information about a specific partition, or with no parameters to display information about both partitions. The following information is displayed:

The display for a specific partition includes the following additional information:

Note: This command provides the same functionality as the system rootfilesystem show command. It is duplicated in the tools command node for easy access when you are working in the tools node.

Options

[-ssid spinserver]

This specifies the SpinServer whose root file-system information is to be displayed.

[-name file_system_name]

This specifies the root file-system partition about which information is to be displayed.

Example

The following example displays information about all root file-system partitions on a SpinServer:

spinserver::> tools system rootfilesystem show 
SpinServer ID   Name     Device   Mount Path  Version   BuildNumber
                                                                   
Server1         ROOT    /dev/md2   /          2.0.0      32012     
Server1         ALTROOT /dev/md1   /altroot   1.1.0      31340     

The following example displays information about the root file-system partition named ROOT on a SpinServer named Server1:

spinserver::> tools system rootfilesystem show -ssid Server1 -name ROOT

   SpinServer ID           Server1
   Name                    ROOT                                    
   Device                  /dev/md2                                
   Mount Path              /                                       
   Version                 2.0.0                                   
   BuildNumber             32012                                   
   InstallTime             10/24/2002-11:14:28                     
   Last Sync Time          UNKNOWN                                 
   Last Config Sync Time   UNKNOWN                                 

Copyright © 2004 Network Appliance, Inc.; copyright © 2003, 2004 Spinnaker Networks, LLC. All rights reserved. Specifications subject to change without notice.